\rcube_imap_search

Class to control search jobs on multiple IMAP folders.

Summary

Methods
Properties
Constants
__construct()
exec()
set_timelimit()
set_results()
get_imap()
$options
No constants found
No protected methods found
$jobs
$timelimit
$results
$conn
N/A
No private methods found
No private properties found
N/A

Properties

$options

$options : array

Type

array — IMAP connection options

$timelimit

$timelimit : int

Type

int — Time limit in seconds

$results

$results : array

Type

array — Search results

Methods

__construct()

__construct(array  $options, \rcube_imap_generic  $conn) : mixed

Default constructor

Parameters

array $options

IMAP connection options

\rcube_imap_generic $conn

IMAP connection object

Returns

mixed —

exec()

exec(array  $folders, string  $str, string  $charset = null, string  $sort_field = null, bool  $threading = null) : mixed

Invoke search request to IMAP server

Parameters

array $folders

List of IMAP folders to search in

string $str

Search criteria

string $charset

Search charset

string $sort_field

Header field to sort by

bool $threading

True if threaded listing is active

Returns

mixed —

set_timelimit()

set_timelimit(int  $seconds) : mixed

Setter for timelimit property

Parameters

int $seconds

Limit in seconds

Returns

mixed —

set_results()

set_results(array  $res) : mixed

Setter for previous (potentially incomplete) search results

Parameters

array $res

Search result

Returns

mixed —

get_imap()

get_imap() : \rcube_imap_generic

Get connection to the IMAP server (used for single-thread mode)

Returns

\rcube_imap_generic —

IMAP connection object